home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / sfrttrv.zip / SFR&TTRV.DOC < prev    next >
Text File  |  1990-09-27  |  20KB  |  499 lines
  1.  
  2.  
  3.  
  4.                              F R E E W A R E
  5.  
  6.                                    from
  7.  
  8.  
  9.                      ╔════════════════════════════════╗
  10.                      ║                                ║
  11.                      ║     █▄                  ▄█     ║
  12.                      ║    ▒░█▀██████    █████▀██░▒    ║
  13.                      ║   ▓▒░███████▀    ▀███████░▒▓   ║
  14.                      ║   ▓▒░███▀            ▀███░▒▓   ║
  15.                      ║   ▓▒░███▄            ▄███░▒▓   ║
  16.                      ║   ▓▒░████▄          ▄████░▒▓   ║
  17.                      ║    ▒░██████▄      ▄██████░▒    ║
  18.                      ║     ████████      ████████     ║
  19.                      ║    ▄▄▄▄▄▄▄▄▄▄    ▄▄▄▄▄▄▄▄▄▄    ║
  20.                      ║    ▄▄▄▄▄▄▄▄▄▄    ▄▄▄▄▄▄▄▄▄▄    ║
  21.                      ║                                ║
  22.                      ╚════════════════════════════════╝
  23.  
  24.                      ╔════════════════════════════════╗
  25.                      ║                                ║
  26.                      ║ ╔═╗ ╔   ╔═╗ ╔═╗ ╔╦╗ ╔═╗  ╦ ╔═╗ ║
  27.                      ║ ╠═  ║   ╠═  ║    ║  ╠═╚╗ ║ ║   ║
  28.                      ║ ╚═╝ ╚═╝ ╚═╝ ╚═╝  ╩  ╩  ╩ ╩ ╚═╝ ║
  29.                      ║   ╦ ╦  ╔╗╦ ╦ ╔═╗ ╦ ╦ ╔╦╗ ╔═╗   ║
  30.                      ║   ╠═╚╗ ║║║ ║ ╠═╗ ╠═╣  ║  ╚═╗   ║
  31.                      ║   ╩  ╩ ╩╚╝ ╩ ╚═╝ ╩ ╩  ╩  ╚═╝   ║
  32.                      ║          ╦═╗ ╦═╗ ╔═╗           ║
  33.                      ║          ╠═╣ ╠═╣ ╚═╗           ║
  34.                      ║          ╩═╝ ╩═╝ ╚═╝           ║
  35.                      ╠════════════════════════════════╣
  36.                      ║    A Registered SPITFIRE BBS   ║
  37.                      ╚════════════════════════════════╝
  38.  
  39.                                 #SF300279
  40.  
  41.                   2400/1200/300 * 8/N/1 * (519) 442-6449
  42.  
  43.  
  44.                            in cooperation with
  45.                           Buffalo Creek Software
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.                                  SFR&TTRV
  68.  
  69.                    SPITFIRE RHYMES & TALES TRIVIA DOOR
  70.  
  71.                             by Heather Story of
  72.  
  73.                            ELECTRIC KNIGHTS BBS
  74.  
  75.  
  76.    INTRODUCTION
  77.    ------------
  78.  
  79.    SFR&TTRV is a fast paced rhyme & tale trivia game designed to run as a
  80.    door feature within the SPITFIRE Bulletin Board System.  It can also be
  81.    installed as a sysop configurable command from the Main, File or
  82.    Message menus of SPITFIRE.  A data file containing over 500 Rhymes and
  83.    tales trivia questions is randomly accessed and displayed to the
  84.    screen.  With each question that is displayed, four multiple choice
  85.    options are provided from which the player may select.  SFR&TTRV allows
  86.    the SYSOP to configure the delay time (defaults to ten seconds) that
  87.    the player is allowed to read the question and respond with the number
  88.    corresponding to the answer they wish to select.
  89.  
  90.  
  91.    SFR&TTRV COMMAND LINE PARAMETERS
  92.    --------------------------------
  93.  
  94.       /P - Designates the drive, path, filename and extension of the
  95.            high score bulletin to be used with SFR&TTRV
  96.  
  97.       /D - Designates the delay time (in seconds) that the user is
  98.            allowed to answer the question before it "times out".
  99.  
  100.       /L - Allows local usage of SFR&TTRV
  101.  
  102.  
  103.    The /P command line parameter is available which will automatically
  104.    create Ansi and Non-Ansi high score bulletins for your BBS system.
  105.    If you would like to use this option, a "/P" should follow the
  106.    SFR&TTRV in the command line to indicate a valid DOS path where the
  107.    bulletin file will be created.  (NOTE: This should be the same as the
  108.    display file path you have set up within SPITFIRE.)  The path is then
  109.    followed by the file name of the bulletin to be created.  It is not
  110.    necessary to include the file extension.  SFR&TTRV will automatically
  111.    add a .BBS extension for the Non-Ansi display file and a .CLR
  112.    extension for the Ansi display file created.  The correct syntax
  113.    should look like this:
  114.  
  115.    SFR&TTRV /P C:\SF\DISPLAY\DORBUL1
  116.  
  117.    The "/P" command line is optional and SFR&TTRV will operate perfectly
  118.    fine without it.  However, it is a convenient means of providing and
  119.    posting high score bulletins for the Canadiana trivia door.
  120.  
  121.  
  122.    The /D command line parameter is also available which will allow the
  123.    Sysop to designate the delay time (in seconds) that is allowed
  124.    between the time the question prompt is displayed to the screen and
  125.    when the user must enter the desired answer.  This is done using the
  126.    /Dnn (where nn represents the number of seconds) command line
  127.    parameter.  As an example, if the Sysop wishes to allow a 15 second
  128.    delay, a /D15 would be entered on the command line as illustrated
  129.    below:
  130.  
  131.    SFR&TTRV /D15
  132.  
  133.    If no /Dnn is designated at the command line, SFR&TTRV will default
  134.    to a ten second delay.
  135.  
  136.  
  137.    The /L command line parameter will allow SFR&TTRV to be played
  138.    locally without requiring a SFDOORS.DAT, SFMAIN.DAT, SFMESS.DAT or
  139.    SFFILE.DAT file.  Using the /L command line parameter disables the
  140.    program's carrier detect monitoring and redirection of the game
  141.    through the comm port.  For local operation of SFR&TTRV enter the
  142.    following command at the DOS prompt:
  143.  
  144.    C:> SFR&TTRV /L
  145.  
  146.    ** SPECIAL NOTE ** The /L, /P and /D command parameters can be used
  147.    together in one command line to specify the drive, path and filename
  148.    of the bulletin to be created and the delay time in seconds when
  149.    playing in local mode.
  150.  
  151.    It should also be noted that the /P, /D and /L command line
  152.    parameters may appear in any order on the command line.  SFR&TTRV
  153.    does NOT require these to be used in a specific order.
  154.  
  155.  
  156.  
  157.    SFR&TTRV SETUP AS A SPITFIRE DOOR
  158.    ---------------------------------
  159.  
  160.    To set up SFR&TTRV to be executed as a door, it is recommended that a
  161.    separate directory be set up for it.  For explanation purposes, let's
  162.    assume the directory DOORA is created for use with SFR&TTRV.  The
  163.    following files must then be placed in the directory:
  164.  
  165.    SFR&TTRV.EXE    The actual game program.
  166.  
  167.    SFR&TTRV.DAT    The data file containing the trivia questions.
  168.  
  169.    SFR&TTRV.TOP    This is a listing of the top ten players.  SFR&TTRV.EXE
  170.                    will create this file if it is not found.
  171.  
  172.    SFR&TTRV.LMT    This allows you to set time limits according to the
  173.                    callers security level.
  174.  
  175.    The Sysop will then need to use a text editor to edit the SF.BAT file
  176.    as illustrated below:
  177.  
  178.    :DOOR_A
  179.    COPY SFDOORS.DAT C:\SF\DOORA
  180.    SFR&TTRV
  181.    ERASE SFDOORS.DAT
  182.    GOTO LOOP
  183.    :DOOR_B
  184.  
  185.  
  186.    You will notice that the commands needed to execute SFR&TTRV are
  187.    placed between the :DOOR_A and GOTO LOOP command lines.  These are
  188.    entered in place of the existing REM Place Program Name Here.  The
  189.    following will briefly explain each of the commands which were set up
  190.    within SF.BAT to run SFR&TTRV as a SPITFIRE Door program:
  191.  
  192.    SFDOORS.DAT is created automatically by SPITFIRE when a user enters a
  193.    door.  It contains information about the user such as name and
  194.    password.  SFR&TTRV requires access to the information within
  195.    SFDOORS.DAT.  Therefore, before executing the program it must be
  196.    copied to the directory in which SFR&TTRV is running.
  197.  
  198.    SFR&TTRV is the program name and executes the game program from
  199.    within the door program.
  200.  
  201.    Once the user has terminated the game play of SFR&TTRV, SPITFIRE
  202.    erases the SFDOORS.DAT file.
  203.  
  204.  
  205.  
  206.    SFR&TTRV SETUP AS A SYSOP CONFIGURABLE COMMAND
  207.    ----------------------------------------------
  208.  
  209.    SPITFIRE has a sysop configurable command for the Main, Message and
  210.    File menus.  The sysop configurable command is executed through a
  211.    batch file which corresponds to the menu it is being run from.  In
  212.    other words, SFMAIN.BAT runs the sysop configurable command from the
  213.    Main Menu, SFMESS.BAT runs the one from the Message Menu and
  214.    SFFILE.BAT the one from the File Menu.  The commands necessary to
  215.    execute SFR&TTRV can be set up in the batch file which corresponds to
  216.    the menu you wish to have SFR&TTRV run from.
  217.  
  218.    The first thing you will need to establish is which of these menus
  219.    you wish to use to run SFR&TTRV.  For this purpose, let's assume that
  220.    it is going to be set up so it can be run from the Main Menu.  (It
  221.    should be noted the set up procedure is the same regardless of which
  222.    Menu you are running SFR&TTRV from.)
  223.  
  224.    Next, you will need to decide what you wish to name the command
  225.    option and establish what security level will be required for users
  226.    of your system to be able to access this option.  Once this is
  227.    determined you will need to modify the SFMAIN.MNU file using your
  228.    favorite text editor, as long as it saves in ASCII format.  (Refer to
  229.    the SPITFIRE manual for further documentation on this if needed.  It
  230.    should also be noted that if SFR&TTRV were being set up to run from
  231.    the File Menu, you would need to modify the SFFILE.MNU file and if it
  232.    was being set up to be run from the Message Menu you would need to
  233.    modify the SFMSG.MNU file.)
  234.  
  235.  
  236.    Examining the default SFMAIN.MNU file, you will notice the sysop
  237.    configurable command appears as:
  238.  
  239.         <K>............. Add Your Own,,1000,@
  240.  
  241.  
  242.    This will need to be replaced with a Command Character that will be
  243.    used to select the option from the menu.  It is ABSOLUTELY IMPERATIVE
  244.    that the Command Character must not duplicate an existing Command
  245.    Character for another menu option.  You will then need to include a
  246.    brief description of the Wildcat door program you are running, two
  247.    commas, the security level required to access this feature, and
  248.    another comma followed by the a @.  The @ must not be changed!  (For
  249.    more detailed information on modifying your SFMAIN.MNU, SFMSG.MNU or
  250.    SFFILE.MNU refer to your SPITFIRE manual.)
  251.  
  252.        <K>.... Brief Program Description,,10,@
  253.  
  254.    Now you will need to modify the corresponding batch file, SFMAIN.BAT,
  255.    so that it can be executed from the Main Menu.  Do this using your
  256.    favorite text editor, as long as it saves in ASCII format.  (Again,
  257.    it should be noted that if SFR&TTRV were being set up to run from the
  258.    File Menu, you would need to modify the SFFILE.BAT file and if it was
  259.    being set up to be run from the Message Menu you would need to modify
  260.    the SFMESS.BAT file.)
  261.  
  262.    Place the SFR&TTRV.EXE file in the directory you wish to run the
  263.    program from.  SFR&TTRV will create its own player score file,
  264.    SFR&TTRV.TOP, if does not already exist.
  265.  
  266.    The commands set up in the SFMAIN.BAT file are very similar to those
  267.    used for executing the game through a door in the SF.BAT file.  For
  268.    instance, if you were running SFR&TTRV from the main SPITFIRE
  269.    directory your SFMAIN.BAT file might look like this:
  270.  
  271.        ECHO OFF
  272.        BRK OFF
  273.        SFR&TTRV
  274.        BRK ON
  275.  
  276.    (BRK is not included in the SFR&TTRV package because it is written
  277.    and copyrighted by Solid Systems, 1985, but can be downloaded from
  278.    The Mother Board BBS and Buffalo Creek's BBS as well as a number of
  279.    other BBS systems.  BRK is not required to run SFR&TTRV, however, it
  280.    is recommended since it will prevent a user using the CTRL BRK
  281.    command to terminate the batch file, gaining access to your system at
  282.    the DOS level.)
  283.  
  284.    If you wish to set SFR&TTRV up in a separate subdirectory from
  285.    SPITFIRE, for instance, a subdirectory named SFR&TTRV, your batch
  286.    file might look like this.
  287.  
  288.        ECHO OFF
  289.        BRK OFF
  290.        COPY SFMAIN.DAT \SF\SFR&TTRV
  291.        CD \SF\SFR&TTRV
  292.        SFR&TTRV
  293.        ERASE SFMAIN.DAT
  294.        CD \SF
  295.        BRK ON
  296.  
  297.  
  298.    When SFR&TTRV is executed, from either the door with the SF.BAT file
  299.    or from the sysop configurable command through a menu with the
  300.    corresponding batch file, it will first look for the SFMAIN.DAT file,
  301.    then the SFMESS.DAT file, then the SFFILE.DAT file and lastly the
  302.    SFDOORS.DAT file.  It will look for each of these files until it
  303.    finds it and the commands required for its execution.  If none of
  304.    these files are found, SFR&TTRV will halt its execution.
  305.  
  306.  
  307.    DTE LOCK FEATURE
  308.    ----------------
  309.  
  310.    SFR&TTRV automatically detects if the DTE is locked at 19200 baud.
  311.    If SFR&TTRV detects that the DTE is locked, then SFR&TTRV opens the
  312.    serial port to the maximum baud rate of your system.  If SFR&TTRV
  313.    does not detect that the DTE is locked, then the serial port is
  314.    opened to the baud rate of the caller.
  315.  
  316.  
  317.    SFR&TTRV ON A MULTI-NODE SYSTEM
  318.    -------------------------------
  319.  
  320.    SFR&TTRV is fully compatible for operation on a multi-node BBS.  It
  321.    automatically handles any file locking and file sharing required
  322.    during the doors execution.
  323.  
  324.  
  325.    SYSOP FEATURES
  326.    --------------
  327.  
  328.    First, a status line is now displayed on the BBS monitor that
  329.    provides information concerning the caller's name, baud rate of the
  330.    caller and the security level of the caller.
  331.  
  332.    A SFR&TTRV.LMT file allows the sysop to establish a time limit for
  333.    door play according to the security level the caller has on the
  334.    system.  To modify the accompanying SFR&TTRV.LMT file, use your
  335.    favorite text editor to represent the various security levels you
  336.    have available on your system, a comma then the corresponding time
  337.    you wish to allow for that particular security level in minutes.  For
  338.    instance, it might look like this:
  339.  
  340.    10,15
  341.    25,20
  342.    50,25
  343.    999,30
  344.  
  345.    Each security level should begin a new line and you should have a
  346.    setting for each security level you have available on your system.
  347.    If you do not have a time limit set for a particular security SFR&TTRV
  348.    will default to the level 10 security level setting.
  349.  
  350.    Pressing the Shift Key and the F1 key simultaneously will terminate
  351.    game play of SFR&TTRV and return the caller back to the BBS.
  352.    Pressing the Shift Key and the F9 key simultaneously will terminate
  353.    game play of SFR&TTRV and log the caller off of the BBS.  If the
  354.    Shift Key and the F9 key are pressed together, logging the caller off
  355.    the BBS, SPITFIRE will recycle and return to the SPITFIRE Ready For
  356.    Caller Prompt.
  357.  
  358.  
  359.    SFR&TTRV EXECUTION
  360.    ------------------
  361.  
  362.    When first executed, SFR&TTRV will display a list of the Top Ten high
  363.    score players and the percentage of correct responses they achieved
  364.    while playing SFR&TTRV.  Initially, this will be a dummy listing with
  365.    ten lines that display:
  366.  
  367.       0%...............YOUR NAME COULD BE HERE
  368.  
  369.    However, as the game is played, this will fill with the name of the
  370.    players, their percentage ratings and the date that the player was
  371.    added to the top ten listing.
  372.  
  373.    NOTE: At least twenty questions must be attempted before SFR&TTRV
  374.          will will figure the percentage rating for the player.
  375.  
  376.    To keep things interesting...the Sysop can erase the file which
  377.    contains the top ten listings SFR&TTRV.TOP on a routine basis to give
  378.    additional players a chance to have their name added to the list.
  379.  
  380.    As the top ten list is displayed, at the bottom of the screen is a
  381.    question which prompts the user whether they want to have ANSI
  382.    Graphics (y/n)?  available to them during game play.  If the user
  383.    responds with a y (for yes) the game will display in color and if the
  384.    user responds with a n (for no) the game will display in monochrome.
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.    PLAYING SFR&TTRV
  400.    ----------------
  401.  
  402.    Immediately after pressing any key (other than <Q> for Quit) from the
  403.    Top Ten listing the game screen is displayed.  The screen will look
  404.    like the following:
  405.  
  406.    ---------------------------------------------------------------------
  407.  
  408.     ╔═════════════════════════════════════════════╗
  409.     ║   >>>>>>> RHYMES & TALES TRIVIA <<<<<<<<<   ║
  410.     ║                 Version 1.0                 ║
  411.     ║  Rhymes & Tales Trivia Door For SPITFIRE!   ║
  412.     ║    Electric Knights BBS * (519) 442-6449    ║
  413.     ║ In Cooperation with Buffalo Creek Software  ║
  414.     ║     Copyright (C) by Heather Story, 1990    ║
  415.     ╚═════════════════════════════════════════════╝
  416.  
  417.     RIGHT: 0                        WRONG: 0
  418.  
  419.     QUESTION:
  420.     The Rhymes & Tales trivia question will be displayed
  421.     here.
  422.  
  423.     <1> Choice 1                        <2> Choice 2
  424.     <3> Choice 3                        <4> Choice 4
  425.  
  426.              Enter Answer: [ 1 2 3 4 <Q>uit]?
  427.  
  428.    ---------------------------------------------------------------------
  429.    The first randomly chosen trivia question is selected from the data
  430.    file and is displayed to the screen.
  431.  
  432.    The player makes his selection by entering the corresponding number.
  433.    As the game progresses, SFR&TTRV will provide a running total of the
  434.    correct answers and also of the wrong answers the user has selected
  435.    during the game play.
  436.  
  437.    If the ten second timer should elapse before you respond, SFR&TTRV
  438.    will count this as a wrong response and add an incorrect answer to
  439.    the total WRONG answers obtained so far.
  440.  
  441.  
  442.    EXITING PLAY
  443.    ------------
  444.  
  445.    When you are ready to exit the game, simply select press "Q" for
  446.    <Q>uit.  If you qualify as one of the top ten players to date,
  447.    SFR&TTRV will congratulate you for becoming one of the top ten
  448.    scorers and add your name to the Top Ten listing.  You will once
  449.    again see the Top Ten list displayed with your name added to the
  450.    list.
  451.  
  452.    If you exit the game before you have completed the twenty questions
  453.    required for eligibility to the Top Ten list or if you do not qualify
  454.    as a Top Ten player, the Top Ten listing will be displayed and you
  455.    will be prompted to press any key to return to SPITFIRE.
  456.  
  457.  
  458.    DISTRIBUTION
  459.    ------------
  460.  
  461.    Please feel free to share SFR&TTRV.ZIP with others.  However, it must
  462.    be distributed with SFR&TTRV.EXE, SFR&TTRV.DAT, SFR&TTRV.TOP,
  463.    SFR&TTRV.LMT and the SFR&TTRV.DOC in the SFR&TTRV.ZIP distribution
  464.    package.  The files must not be altered in any way or by any means.
  465.  
  466.  
  467.    PUBLIC DOMAIN - DISCLAIMER
  468.    --------------------------
  469.  
  470.    SFR&TTRV is distributed under the public domain concept.  The
  471.    software and its accompanying documentation are provided "as is"
  472.    without warranties expressed or implied as to the performance or
  473.    merchantability.  No registration fee is required and the program can
  474.    be distributed freely.  However, by the use of SFR&TTRV, the user
  475.    assumes all responsibilities and agrees that Heather Story or
  476.    Electric Knights BBS or Bill Brown shall not be held liable for any
  477.    damage incurred to hardware, software or peripheral devices while
  478.    running same.
  479.  
  480.    Many thanks are indeed owed to Mike Woltz of Buffalo Creek BBS (515)-
  481.    225-8496 for his assistance.  Without his help this program would not
  482.    have been possible.
  483.  
  484.  
  485.    History
  486.    -------
  487.  
  488.    Release 1    SFR&TTRV released.
  489.  
  490.  
  491.  
  492.    SFR&TTRV and other SPITFIRE programs are available for download from:
  493.  
  494.         Buffalo Creek BBS                   Electric Knights BBS
  495.         Sysop - Mike Woltz                   Sysop - Bill Brown
  496.           (515) 225-8496                        (519) 442-6449
  497.        19200/9600/2400/1200                      2400/1200/300
  498.  
  499.